Skip to main content
Feedback

Developer Portal Publishing category

The Developer Portal Publishing category of operations is used to publish a Developer Portal and retrieve details about a Developer Portal.

Supported operations

The Developer Portal Publishing categoryis supported in the following operations:

OperationQUERYMUTATION
Developer Portal✅ SupportedX Not supported
Update Developer PortalX Not supported✅ Supported

Currently, there is no support for fields for use as QUERY filters for the Developer Portal Publishing object.

Query syntax

devportal(Id: String!) {DevPortal}

Mutation syntax

devPortalUpdate(id: ID!, devPortalInput: DevPortalInput!): DevPortalUpdateResult!

Input and return fields syntax

Update Developer Portal Mutation input syntax

input DevPortalInput {
   internalName: String
   theme: DevPortalThemeInput
   environments: [EnvironmentInput]
   environmentFilterEnabled: Boolean
}

Update Developer Portal Theme Mutation input syntax

input DevPortalThemeInput {
   text: DevPortalTextInput
   colors: DevPortalColorsInput
   logo: ImageInput
}

Update Developer Portal Message Mutation input syntax

input DevPortalTextInput {
   publishedName: String
   welcomeMessage: String
}

Update Developer Portal Colors Mutation input syntax

input DevPortalColorsInput {
   siteFrameworkColor: String
   contentBackgroundColor: String
   borderColor: String
   primaryTextColor: String
   linkColor: String
   selectedItemColor: String
   headingColor: String
}

Update Developer Portal Logo Details Mutation input syntax

input ImageInput {
   content: String
   type: String
   altText: String
}

Update Developer Portal Environment Mutation input syntax

input EnvironmentInput {
   id: ID!
   publishedName: String
}

Return fields syntax

type DevPortal {
   id: ID!
   internalName: String
   theme: DevPortalTheme
   environmentFilterEnabled: Boolean
   gateway: Gateway
}
FieldTypeDescription
idIDThe ID of the API Gateway.
internalNamestringThe Developer Portal's internal name.
themeDevPortalThemeThe Developer Portal's theme.
environmentFilterEnabledbooleanIdentifies whether the environment filter is enabled or not.
gatewayGatewayThe API Gateway onto which the Developer Portal attaches.For details about the type Gateway input parameters, see Gateway category.
type DevPortalTheme {
   text: DevPortalText
   colors: DevPortalColors
   logo: Image
}
FieldTypeDescription
textDevPortalTextThe welcome message associated with your Developer Portal.
colorsDevPortalColorsThe custom colors associated with your Developer Portal.
logoimageThe logo associated with your Developer Portal.
type DevPortalText {
   publishedName: String
   welcomeMessage: String
}
FieldTypeDescription
publishedNamestringThe Developer Portal's published name.
welcomeMessagestringThe Developer Portal's welcome message.
type DevPortalColors {
   siteFrameworkColor: String
   contentBackgroundColor: String
   borderColor: String
   primaryTextColor: String
   linkColor: String
   selectedItemColor: String
   headingColor: String
}
FieldTypeDescription
siteFrameworkColorstringThe hex color code for the site framework of your Developer Portal.
contentBackgroundColorstringThe hex color code for the content background color of your Developer Portal.
borderColorstringThe hex color code for the border color of your Developer Portal.
primaryTextColorstringThe hex color code for the primary text on your Developer Portal.
linkColorstringThe hex color code for link text on your Developer Portal.
selectedItemColorstringThe hex color code for selected items on your Developer Portal.
headingColorstringThe hex color code for the heading on your Developer Portal.
type Image {
   content: String
   type: String
   altText: String
}
FieldTypeDescription
contentstringThe logo image used for your Developer Portal. Your site logo is limited to 50 pixels in height and 200 pixels in width. The maximum file size is 1MB in the .jpg, .png, or .svg format.
typestringThe type of image used for your Developer Portal. Accepted image types are .jpg, .png, or .svg formats.
altTextstringThe alternative text for the logo image used for your Developer Portal.
type DevPortalUpdateResult {
    status: DevPortalUpdateStatus!
    warnings: [DevPortalUpdateWarning]
}

enum DevPortalUpdateStatus{
    SAVED,
    SAVED_WITH_WARNINGS,
    FAILED_VALIDATION,
    ERROR
}
FieldTypeDescription
statusDevPortalUpdateStatusUsed to identify the status of the request.
warningsDevPortalUpdateWarningIdentifies warnings in publishing the Developer Portal.
type DevPortalUpdateWarning {
    entityIds: [String]
    errorCode: DevPortalUpdateErrorCode
    message: String
    severity: ErrorSeverity
}

type DevPortalUpdateErrorCode {
    ILLEGAL_ELEMENT
    ILLEGAL_ATTRIBUTES
    ATTRIBUTES_BAD_OR_MISSING
    ATTRIBUTES_MAX_LENGTH
    ATTRIBUTES_MIN_LENGTH
    ILLEGAL_STYLE
    HEADING_OUT_OF_ORDER
    IMG_ALT_TEXT_EMPTY
    GATEWAY_ID_EMPTY
    GATEWAY_NOT_FOUND
    INTERNAL_NAME_EMPTY
    INTERNAL_NAME_TOO_LONG
    PUBLISHED_NAME_EMPTY
    PUBLISHED_NAME_TOO_LONG
    WELCOME_MESSAGE_TOO_LONG
    SITE_FRAMEWORK_COLOR_EMPTY
    SITE_FRAMEWORK_COLOR_INVALID
    CONTENT_BACKGROUND_COLOR_EMPTY
    CONTENT_BACKGROUND_COLOR_INVALID
    BORDER_COLOR_EMPTY
    BORDER_COLOR_INVALID
    PRIMARY_TEXT_COLOR_EMPTY
    PRIMARY_TEXT_COLOR_INVALID
    LINK_COLOR_EMPTY
    LINK_COLOR_INVALID
    SELECTED_ITEM_COLOR_EMPTY
    SELECTED_ITEM_COLOR_INVALID
    HEADING_COLOR_EMPTY
    HEADING_COLOR_INVALID
    COLOR_CONTRAST_INVALID
    LOGO_EMPTY
    LOGO_NOT_BASE64
    LOGO_TOO_LARGE
    LOGO_IMAGE_TYPE_EMPTY
    LOGO_IMAGE_TYPE_UNSUPPORTED
    LOGO_ALT_TEXT_TOO_LONG
    LOGO_ALT_TEXT_EMPTY
    LOGO_ALT_TEXT_NULL
    ENVIRONMENT_NOT_FOUND
    ENVIRONMENT_NOT_ON_GATEWAY
    ENVIRONMENT_PUBLISHED_NAME_INVALID
    PUBLISHED_NAME_ALREADY_USED_ON_GATEWAY
    INPUT_CONTAINS_DUPLICATED_PUBLISHED_NAMES
}

type ErrorSeverity {
    WARNING,
    ERROR
}
FieldTypeDescription
entityIdsstringThe ID of the fields that failed validation. For example, if there is an error in the welcome message's heading order, it identifies the elements within the heading that caused the error.
errorCodeErrorSeverityIdentifies the type of the error.
messagestringThe error message.
severityErrorSeverityThe error severity of WARNING or ERROR.

GraphQL implementation

  • QUERY operation

    The following example queries the Developer Portal title and content on the home page.

    Each of the fields within the query are optional, based on the data that you want to return. For instance, you can query on internalName only, if you only want to return the Internal Name of the Developer Portal.

    For a GraphQL request, send a request to https://platform.boomi.com/graphql with the following header: X-Account accountId

    Request:

    query {
        devportal(id: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>") {
            internalName,
            publishedName,
            welcomeMessage
        }
    }

    JSON response:

    {
      "data": {
         "devportal": {
    "internalName": "BizCo Developer Portal",
    "publishedName": "Business Company, Inc. Developer Portal",
    "welcomeMessage": "<p>Welcome to the developer portal for Business Company, where you can sample and subscribe to our APIs.<p>"
        }
      }
    }

  • updateDeveloperPortal operation

    The following example updates a Developer Portal's title and home page.

    For a GraphQL request, send a request to https://platform.boomi.com/graphql with the following header: X-AccountaccountId

    tip

    If you modify the welcome message using any HTML tag that we do not support, the Developer Portal rejects the API call with an error message.

    Request:

    mutation {
        devPortalUpdate(
            id: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
            devPortalInput: {
                internalName:"BizCo Developer Portal",
                publishedName: "Business Company, Inc. Developer Portal",
                welcomeMessage: "<p>Welcome to the developer portal for BizCo, where you can sample and subscribe to our APIs.<p>"
            }
            ) {
                status,
                warnings {
                entityIds,
                errorCode,
                message,
                severity
            }
        }
    }

    JSON response:

    {
        "data": {
            "devPortalUpdate": {
                "status": "SAVED",
                "warnings": []
            }
        }
    }

Audit log usage

{
  "QueryFilter" :
    {
      "expression" : {
          "operator" : "and",
          "nestedExpression" : [
            {
              "argument" : ["admin@boomi.com"],
              "operator" : "EQUALS",
              "property" : "userId"
            },
            {
              "argument" : ["api-portal_publishing"],
              "operator" : "EQUALS",
              "property" : "type"
            },          
            {
              "argument" : ["2021-03-28T00:00:00Z","2021-03-29T23:59:59Z"],
              "operator":"BETWEEN",
              "property":"date"
            }
          ]
        }
    }
}
On this Page